/*
 * Copyright (c) 2008, Roman Bosak
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the DailyDevelopment nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.dailydev.jira.portal.config;

/**
 * Default implementation of {@link ISharedPortalPage} interface.
 * 
 * @author Roman Bosak, roman.bosak@gmail.com
 */
public class SharedPortalPage implements ISharedPortalPage {

    /**
     * Field storing value of group name.
     */
    private final String groupName;

    /**
     * Field storing value of portal page ID.
     */
    private final Long portalPageId;

    /**
     * Field storing value of author name.
     */
    private final String author;

    /**
     * Constructor for {@link SharedPortalPage}.
     * 
     * @param dashboardId
     *            Id of the portal page which sharing configuration this
     *            {@link SharedPortalPage} represents
     * @param author
     *            Name of author of the portal page
     * @param groupName
     *            Name of group to which the portal page will be shared or null
     *            if portal page should be shared to all users
     */
    public SharedPortalPage(Long dashboardId, String author, String groupName) {
        this.portalPageId = dashboardId;
        this.author = author;
        this.groupName = groupName;
    }

    /** {@inheritDoc} */
    public String getAuthor() {
        return author;
    }

    /** {@inheritDoc} */
    public Long getDashboardId() {
        return portalPageId;
    }

    /** {@inheritDoc} */
    public String getGroupName() {
        return groupName;
    }

    /**
     * Returns {@link String} representation of this {@link SharedPortalPage}.
     * 
     * @return {@link String} representation of this {@link SharedPortalPage}
     */
    @Override
    public String toString() {
        return "Shared portal page: author> " + author + "; ID> "
                + portalPageId + "; group> " + groupName;
    }

}
